 | This document contains information for Confluence plugin developers regarding changes to the Confluence codebase in the upcoming 3.1 release. |
Confluence 3.1 Deprecation Cleanup
Every major Confluence release, we clean up the codebase by removing classes and methods that have been deprecated in previous releases. These changes were included in the Milestone 2 release of Confluence 3.1. We strongly encourage plugin developers to test their plugins against our milestone releases.
If the removal of these classes or methods causes you significant problems maintaining your plugins, please let us know. We will work with you to find a workaround, or possibly reinstate the code before the final release. (Note that the longer the code in question has been deprecated, the less inclined we will be to replace it. Some of the stuff we've removed here will have been giving you compiler warnings for years.)
More information on our guidelines for removing deprecated code: Deprecation Guidelines
Changes in Confluence 3.1 Milestone 2
 | For the sake of brevity, the com.atlassian.confluence part of package names has been omitted. |
Removed Classes
| Class | Deprecated Since |
|---|---|
| .pages.BreadcrumbsManager .pages.DefaultBreadcrumbsManager |
2.7 |
| .plugin.descriptor.web.conditions.user.UserHasHistoryCondition | 2.8 |
| .util.VelocityUtils | 2.0 |
| .util.PageComparator | 2.3 |
| .util.ResourceManager com.atlassian.confluence.util.DefaultResourceManager |
2.8 |
| .event.EventListener com.atlassian.confluence.event.DeprecatedEventListenerWrapper |
2.3 |
| .servlet.download.ResourceDownload | 2.101 |
| .renderer.radeox.macros.include.AbstractHttpRetrievalMacro | 2.72 |
| .macro.macros.AbstractHtmlGeneratingMacro | 2.72 |
| bucket.search.EntityObjectDateExtractor | 1.4 |
| bucket.container.ContainerManager bucket.container.ContainerContext |
2.3 |
1 While the ResourceDownload class was only deprecated in 2.10, it could only ever be used in the context of the ResourceManager which was deprecated earlier. It is very unlikely that code exists that relies on one but not the other.
2 These Radeox macros were superseded by the equivalent V2Renderer macros in Confluence 1.4, but only marked as deprecated in the 2.7 release
Removed Constants
| Since Java inlines constant references during compilation, the removal of constants should not break binary compatibility with any plugin that references them. |
| Class | Constant | Deprecated Since |
|---|---|---|
| .search.lucene.extractor.PageContentEntityObjectExtractor | PAGE_REAL_TITLE | 2.8 |
| .security.SpacePermission | ADMINISTER_CONFLUENCE_PERMISSION | 2.7 |
| .setup.Bandana.ConfluenceDaoBandanaPersister | GLOBAL_BANDANA_CONTEXT | 2.8 |
Removed Methods
| Class | Method | Deprecated Since | Notes |
|---|---|---|---|
| .core.ConfluenceActionSupport | ThemeHelper getGlobalHelper() | 2.0 | Support for pre-2.0 themes |
| ThemeHelper getSpaceHelper() | 2.0 | Support for pre-2.0 themes | |
| .core.ContentEntityManager | Iterator getRecentlyModifiedEntities(int maxResults) | 2.0 | use the SearchManager for this kind of query |
| .core.ContentEntityObject | String getRealTitle() | 2.8 | use getDisplayTitle() instead |
| .core.ContentPermissionManager | List getInheritedViewContentPermissions(Page page) | 2.5 | |
| .core.persistence.ContentEntityObjectDao | Iterator getRecentlyModifiedEntitiesByType(ListQuery query, int firstResult) | 2.8 | use the SearchManager for this kind of query |
| .importexport.ExportContext | DateFormatter getDateFormatter() | 2.8.2 | |
| .pages.AttachmentUtils | static File getOldContainingFolder(Attachment attachment) | 2.2 | |
| .pages.actions.ViewPageAttachmentsAction | AttachmentHelper getTargetHelper(Attachment attachment) | 2.8 | use getWebInterfaceContext() |
| .plugin.editor.Editor | String getEditorSpecificCss() | 2.8 | |
| .security.ContentPermission | String getGroup() | 2.4 | use getGroupName() |
| .security.PermissionManager | boolean isGlobalAdministrator(User user) | 2.7 | use isConfluenceAdministrator() |
| .setup.BootstrapManager | boolean isConfluenceHomeValid() boolean isWebdavEnabled() void setBaseUrl(String baseUrl) |
2.8 | use SettingsManager |
| .spaces.SpaceManager | boolean isValidSpaceKey(String key) | 2.3 | use Space.isValidGlobalSpaceKey() |
| boolean.isValidPersonalSpaceKey(String key) | 2.3 | use Space.isValidPersonalSpaceKey() | |
| List getPages(Space space, boolean currentOnly) List getPagesStartingWith(Space space, String prefix) List getBlogPosts(Space space, boolean currentOnly) List getMail(Space space, boolean currentOnly) List getSpaces() list getSpacesCreatedOrUpdatedSinceDate(Date date) |
2.3 | ||
| .spaces.Space | List getPages() List getCurrentPages() List getBlogPosts() List getCurrentBlogPosts() List getMail() List getCurrentMail() |
2.3 | use PageManager |
| .user.PersonalInformationManager | PersonalInformation getPersonalInformation(String username) | 2.3 | use getPersonalInformation(User user) |
| .user.SearchEntitiesManager | SearchResult findGroups(TermQuery query) | 2.8 | use findGroupsAsList() |
| SearchResult findGroups(TermQuery query, boolean filter) | 2.8 | use findGroupsAsList() | |
| SearchResult findUsers(Query query) | 2.8 | use findUsersAsList() | |
| .util.GeneralUtil | String format(Date date) formatTime(Date date) formatBlogDate(Date date) formatDateTime(Date date) |
2.3 | use $dateFormatter |
| isGlobalAdministrator(Object notUsedAnyMore, User user) | 2.0 | use PermissionManager or $permissionHelper | |
| getProperties(String resource, Class caller) getPropertiesFromFile(File file) getPropertiesFromStream(InputStream is) |
2.3 | use PropertyUtils | |
| .upgrade.AbstractUpgradeTask | addError(String message) addError(Throwable throwable) |
1.2 | use addError(UpgradeError error) |
